~ubuntu-branches/ubuntu/precise/mysql-5.1/precise

The management server is the process that reads the cluster configuration file and distributes this information to all nodes in the cluster that request it\&. It also maintains a log of cluster activities\&. Management clients can connect to the management server and check the cluster\'s status\&.

.\" MySQL Cluster: administration

.\" MySQL Cluster: commands

.\" command options (MySQL Cluster): ndb_mgmd

.\" MySQL Cluster: mgmd process

.PP

The following table includes options that are specific to the MySQL Cluster management server program

\fBndb_mgmd\fR\&. Additional descriptions follow the table\&. For options common to all MySQL Cluster programs, see

Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --bind-address option (ndb_mgmd)

\fB\-\-bind\-address=\fR\fB\fIhost\fR\fR\fB[:\fR\fB\fIport\fR\fR\fB]\fR

.TS

allbox tab(:);

l l s

^ l l

^ l l.

\fBVersion Introduced\fR

T}:T{

5\&.1\&.22\-ndb\-6\&.3\&.2

\fBCommand\-Line Format\fR

T}:T{

\-\-bind\-address

\ \&

T}:T{

\fBPermitted Values \fR

:T{

\fBType\fR

T}:T{

string

:T{

\fBDefault\fR

T}:T{

[none]

.TE

.sp 1

When specified, this option limits management server connections by management clients to clients at the specified host name or IP address (and possibly port, if this is also specified)\&. In such cases, a management client attempting to connect to the management server from any other address fails with the error

Unable to setup port: \fIhost\fR:\fIport\fR!

.sp

If the

\fIport\fR

is not specified, the management client attempts to use port 1186\&.

.sp

This option was added in MySQL Cluster NDB 6\&.2\&.5 and MySQL Cluster NDB 6\&.3\&.2\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

100

.\}

101

.el \{\

102

.sp -1

103

.IP \(bu 2.3

104

.\}

105

.\" --configdir option (ndb_mgmd)

106

\fB\-\-configdir=\fR\fB\fIdirectory\fR\fR

107

.TS

108

allbox tab(:);

109

l l s

110

l l s

111

l l s

112

^ l l

113

^ l l.

114

115

\fBVersion Introduced\fR

116

T}:T{

117

5\&.1\&.30\-ndb\-6\&.4\&.0

118

119

120

\fBCommand\-Line Format\fR

121

T}:T{

122

\-\-configdir=directory

123

124

125

\ \&

126

T}:T{

127

\fBPermitted Values \fR

128

129

:T{

130

\fBType\fR

131

T}:T{

132

filename

133

134

:T{

135

\fBDefault\fR

136

T}:T{

137

$INSTALLDIR/mysql\-cluster

138

139

.TE

140

.sp 1

141

Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is cached internally rather than being read from the cluster global configuration file each time the management server is started (see

142

Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. This option instructs the management server to its configuration cache in the

143

\fIdirectory\fR

144

indicated\&. By default, this is a directory named

145

mysql\-cluster

146

in the MySQL installation directory \(em for example, if you compile and install MySQL Cluster on a Unix system using the default location, this is

147

/usr/local/mysql\-cluster\&.

148

.sp

149

This behavior can be overridden using the

150

\fB\-\-initial\fR

151

152

\fB\-\-reload\fR

153

option for

154

\fBndb_mgmd\fR\&. Each of these options is described elsewhere in this section\&.

155

.sp

156

This option is available beginning with MySQL Cluster NDB 6\&.4\&.0\&.

157

.sp

158

Beginning with MySQL Cluster NDB 7\&.0\&.8,

159

\fB\-\-config\-dir\fR

160

is accepted as an alias for

161

\fB\-\-configdir\fR\&.

162

.RE

163

.sp

164

.RS 4

165

.ie n \{\

166

\h'-04'\(bu\h'+03'\c

167

.\}

168

.el \{\

169

.sp -1

170

.IP \(bu 2.3

171

.\}

172

.\" --config-file option (ndb_mgmd)

173

.\" -f option (ndb_mgmd)

174

.\" -c option (ndb_mgmd) (OBSOLETE)

175

\fB\-\-config\-file=\fR\fB\fIfilename\fR\fR,

176

\fB\-f \fR\fB\fIfilename\fR\fR

177

.TS

178

allbox tab(:);

179

l l s

180

l l s

181

^ l l

182

^ l l.

183

184

\fBCommand\-Line Format\fR

185

T}:T{

186

\-c

187

188

189

\ \&

190

T}:T{

191

\fBPermitted Values \fR

192

193

:T{

194

\fBType\fR

195

T}:T{

196

filename

197

198

:T{

199

\fBDefault\fR

200

T}:T{

201

\&./config\&.ini

202

203

.TE

204

.sp 1

205

Instructs the management server as to which file it should use for its configuration file\&. By default, the management server looks for a file named

206

config\&.ini

207

in the same directory as the

208

\fBndb_mgmd\fR

209

executable; otherwise the file name and location must be specified explicitly\&.

210

.sp

211

Beginning with MySQL Cluster NDB 6\&.4\&.0, this option is ignored unless the management server is forced to read the configuration file, either because

212

\fBndb_mgmd\fR

213

was started with the

214

\fB\-\-reload\fR

215

216

\fB\-\-initial\fR

217

option, or because the management server could not find any configuration cache\&. See

218

Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq, for more information\&.

219

.RE

220

.sp

221

.RS 4

222

.ie n \{\

223

\h'-04'\(bu\h'+03'\c

224

.\}

225

.el \{\

226

.sp -1

227

.IP \(bu 2.3

228

.\}

229

.\" --daemon option (ndb_mgmd)

230

.\" -d option (ndb_mgmd)

231

\fB\-\-daemon\fR,

232

\fB\-d\fR

233

.TS

234

allbox tab(:);

235

l l s

236

l l s

237

^ l l

238

^ l l.

239

240

\fBCommand\-Line Format\fR

241

T}:T{

242

\-\-daemon

243

244

245

\ \&

246

T}:T{

247

\fBPermitted Values \fR

248

249

:T{

250

\fBType\fR

251

T}:T{

252

boolean

253

254

:T{

255

\fBDefault\fR

256

T}:T{

257

TRUE

258

259

.TE

260

.sp 1

261

Instructs

262

\fBndb_mgmd\fR

263

to start as a daemon process\&. This is the default behavior\&.

264

.sp

265

This option has no effect when running

266

\fBndb_mgmd\fR

267

on Windows platforms\&.

268

.RE

269

.sp

270

.RS 4

271

.ie n \{\

272

\h'-04'\(bu\h'+03'\c

273

.\}

274

.el \{\

275

.sp -1

276

.IP \(bu 2.3

277

.\}

278

.\" --initial option (ndb_mgmd)

279

\fB\-\-initial\fR

280

.TS

281

allbox tab(:);

282

l l s

283

l l s

284

l l s

285

^ l l

286

^ l l.

287

288

\fBVersion Introduced\fR

289

T}:T{

290

5\&.1\&.30\-ndb\-6\&.4\&.0

291

292

293

\fBCommand\-Line Format\fR

294

T}:T{

295

\-\-initial

296

297

298

\ \&

299

T}:T{

300

\fBPermitted Values \fR

301

302

:T{

303

\fBType\fR

304

T}:T{

305

boolean

306

307

:T{

308

\fBDefault\fR

309

T}:T{

310

FALSE

311

312

.TE

313

.sp 1

314

Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is cached internally rather than being read from the cluster global configuration file each time the management server is started (see

315

Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. Using this option overrides this behavior, by forcing the management server to delete any existing cache files, and then to re\-read the configuration data from the cluster configuration file and to build a new cache\&.

316

.sp

317

This differs in two ways from the

318

\fB\-\-reload\fR

319

option\&. First,

320

\fB\-\-reload\fR

321

forces the server to check the configuration file against the cache and reload its data only if the contents of the file are different from the cache\&. Second,

322

\fB\-\-reload\fR

323

does not delete any existing cache files\&.

324

.sp

325

326

\fBndb_mgmd\fR

327

is invoked with

328

\fB\-\-initial\fR

329

but cannot find a global configuration file, the management server cannot start\&.

330

.sp

331

This option was introduced in MySQL Cluster NDB 6\&.4\&.0\&.

332

.RE

333

.sp

334

.RS 4

335

.ie n \{\

336

\h'-04'\(bu\h'+03'\c

337

.\}

338

.el \{\

339

.sp -1

340

.IP \(bu 2.3

341

.\}

342

.\" --log-name option (ndb_mgmd)

343

\fB\-\-log\-name=\fR\fB\fIname\fR\fR

344

.TS

345

allbox tab(:);

346

l l s

347

l l s

348

l l s

349

^ l l

350

^ l l.

351

352

\fBVersion Introduced\fR

353

T}:T{

354

5\&.1\&.37\-ndb\-7\&.0\&.8

355

356

357

\fBCommand\-Line Format\fR

358

T}:T{

359

\-\-log\-name=

360

361

362

\ \&

363

T}:T{

364

\fBPermitted Values \fR

365

366

:T{

367

\fBType\fR

368

T}:T{

369

string

370

371

:T{

372

\fBDefault\fR

373

T}:T{

374

MgmtSrvr

375

376

.TE

377

.sp 1

378

Provides a name to be used for this node in the cluster log\&.

379

.sp

380

This option was added in MySQL Cluster NDB 7\&.0\&.8\&.

381

.RE

382

.sp

383

.RS 4

384

.ie n \{\

385

\h'-04'\(bu\h'+03'\c

386

.\}

387

.el \{\

388

.sp -1

389

.IP \(bu 2.3

390

.\}

391

.\" --nodaemon option (ndb_mgmd)

392

\fB\-\-nodaemon\fR

393

.TS

394

allbox tab(:);

395

l l s

396

l l s

397

^ l l

398

^ l l

399

l l s

400

^ l l

401

^ l l.

402

403

\fBCommand\-Line Format\fR

404

T}:T{

405

\-\-nodaemon

406

407

408

\ \&

409

T}:T{

410

\fBPermitted Values \fR

411

412

:T{

413

\fBType\fR

414

T}:T{

415

boolean

416

417

:T{

418

\fBDefault\fR

419

T}:T{

420

FALSE

421

422

423

\ \&

424

T}:T{

425

\fBPermitted Values \fR

426

427

:T{

428

\fBType\fR (windows)

429

T}:T{

430

boolean

431

432

:T{

433

\fBDefault\fR

434

T}:T{

435

TRUE

436

437

.TE

438

.sp 1

439

Instructs

440

\fBndb_mgmd\fR

441

not to start as a daemon process\&.

442

.sp

443

As of MySQL Cluster NDB 7\&.0\&.8, the default behavior for

444

\fBndb_mgmd\fR

445

on Windows is to run in the foreground, making this option unnecessary on Windows platforms\&. (\m[blue]\fBBug#45588\fR\m[]\&\s-2\u[1]\d\s+2)

446

.RE

447

.sp

448

.RS 4

449

.ie n \{\

450

\h'-04'\(bu\h'+03'\c

451

.\}

452

.el \{\

453

.sp -1

454

.IP \(bu 2.3

455

.\}

456

.\" --print-full-config option (ndb_mgmd)

457

.\" -P option (ndb_mgmd)

458

\fB\-\-print\-full\-config\fR,

459

\fB\-P\fR

460

.TS

461

allbox tab(:);

462

l l s

463

l l s

464

^ l l

465

^ l l.

466

467

\fBCommand\-Line Format\fR

468

T}:T{

469

\-\-print\-full\-config

470

471

472

\ \&

473

T}:T{

474

\fBPermitted Values \fR

475

476

:T{

477

\fBType\fR

478

T}:T{

479

boolean

480

481

:T{

482

\fBDefault\fR

483

T}:T{

484

FALSE

485

486

.TE

487

.sp 1

488

Shows extended information regarding the configuration of the cluster\&. With this option on the command line the

489

\fBndb_mgmd\fR

490

process prints information about the cluster setup including an extensive list of the cluster configuration sections as well as parameters and their values\&. Normally used together with the

491

\fB\-\-config\-file\fR

492

(\fB\-f\fR) option\&.

493

.RE

494

.sp

495

.RS 4

496

.ie n \{\

497

\h'-04'\(bu\h'+03'\c

498

.\}

499

.el \{\

500

.sp -1

501

.IP \(bu 2.3

502

.\}

503

.\" --reload option (ndb_mgmd)

504

\fB\-\-reload\fR

505

.TS

506

allbox tab(:);

507

l l s

508

l l s

509

l l s

510

^ l l

511

^ l l.

512

513

\fBVersion Introduced\fR

514

T}:T{

515

5\&.1\&.30\-ndb\-6\&.4\&.0

516

517

518

\fBCommand\-Line Format\fR

519

T}:T{

520

\-\-reload

521

522

523

\ \&

524

T}:T{

525

\fBPermitted Values \fR

526

527

:T{

528

\fBType\fR

529

T}:T{

530

boolean

531

532

:T{

533

\fBDefault\fR

534

T}:T{

535

FALSE

536

537

.TE

538

.sp 1

539

Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is stored internally rather than being read from the cluster global configuration file each time the management server is started (see

540

Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. Using this option forces the management server to check its internal data store against the cluster configuration file and to reload the configuration if it finds that the configuration file does not match the cache\&. Existing configuration cache files are preserved, but not used\&.

541

.sp

542

This differs in two ways from the

543

\fB\-\-initial\fR

544

option\&. First,

545

\fB\-\-initial\fR

546

causes all cache files to be deleted\&. Second,

547

\fB\-\-initial\fR

548

forces the management server to re\-read the global configuration file and construct a new cache\&.

549

.sp

550

If the management server cannot find a global configuration file, then the

551

\fB\-\-reload\fR

552

option is ignored\&.

553

.sp

554

This option was introduced in MySQL Cluster NDB 6\&.4\&.0\&.

555

.RE

556

.sp

557

.RS 4

558

.ie n \{\

559

\h'-04'\(bu\h'+03'\c

560

.\}

561

.el \{\

562

.sp -1

563

.IP \(bu 2.3

564

.\}

565

.\" --nowait-nodes option (ndb_mgmd)

566

\fB\-\-nowait\-nodes\fR

567

.TS

568

allbox tab(:);

569

l l s

570

l l s

571

l l s

572

^ l l

573

^ l l

574

^ l l.

575

576

\fBVersion Introduced\fR

577

T}:T{

578

5\&.1\&.39\-ndb\-7\&.1\&.0

579

580

581

\fBCommand\-Line Format\fR

582

T}:T{

583

\-\-nowait\-nodes=list

584

585

586

\ \&

587

T}:T{

588

\fBPermitted Values \fR

589

590

:T{

591

\fBType\fR

592

T}:T{

593

numeric

594

595

:T{

596

\fBDefault\fR

597

T}:T{

598

599

:T{

600

\fBRange\fR

601

T}:T{

602

1\-255

603

604

.TE

605

.sp 1

606

When starting a MySQL Cluster is configured with two management nodes and running MySQL Cluster NDB 7\&.0 and later, each management server normally checks to see whether the other

607

\fBndb_mgmd\fR

608

is also operational and whether the other management server\'s configuration is identical to its own\&. However, it is sometimes desirable to start the cluster with only one management node (and perhaps to allow the other

609

\fBndb_mgmd\fR

610

to be started later)\&. This option causes the management node to bypass any checks for any other management nodes whose node IDs are passed to this option, allowing the cluster to start as though configured to use only the management node that was started\&.

611

.sp

612

For purposes of illustration, consider the following portion of a

613

config\&.ini

614

file (where we have omitted most of the configuration parameters that are not relevant to this example):

615

.sp

616

.if n \{\

617

.RS 4

618

.\}

619

.nf

620

[ndbd]

621

NodeId = 1

622

HostName = 192\&.168\&.0\&.101

623

[ndbd]

624

NodeId = 2

625

HostName = 192\&.168\&.0\&.102

626

[ndbd]

627

NodeId = 3

628

HostName = 192\&.168\&.0\&.103

629

[ndbd]

630

NodeId = 4

631

HostName = 192\&.168\&.0\&.104

632

[mgm]

633

NodeId = 10

634

HostName = 192\&.168\&.0\&.150

635

[mgm]

636

NodeId = 11

637

HostName = 192\&.168\&.0\&.151

638

[api]

639

NodeId = 20

640

HostName = 192\&.168\&.0\&.200

641

[api]

642

NodeId = 21

643

HostName = 192\&.168\&.0\&.201

644

.fi

645

.if n \{\

646

.RE

647

.\}

648

.sp

649

Assume that you wish to start this cluster using only the management server having node ID

650

651

and running on the host having the IP address 192\&.168\&.0\&.150\&. (Suppose, for example, that the host computer on which you intend to the other management server is temporarily unavailable due to a hardware failure, and you are waiting for it to be repaired\&.) To start the cluster in this way, use a command line on the machine at 192\&.168\&.0\&.150 to enter the following command:

652

.sp

653

.if n \{\

654

.RS 4

655

.\}

656

.nf

657

shell> \fBndb_mgmd \-\-ndb\-nodeid=10 \-\-nowait\-nodes=11\fR

658

.fi

659

.if n \{\

660

.RE

661

.\}

662

.sp

663

As shown in the preceding example, when using

664

\fB\-\-nowait\-nodes\fR, you must also use the

665

\fB\-\-ndb\-nodeid\fR

666

option to specify the node ID of this

667

\fBndb_mgmd\fR

668

process\&.

669

.sp

670

You can then start each of the cluster\'s data nodes in the usual way\&. If you wish to start and use the second management server in addition to the first management server at a later time without restarting the data nodes, you must start each data node with a connectstring that references both management servers, like this:

671

.sp

672

.if n \{\

673

.RS 4

674

.\}

675

.nf

676

shell> \fBndbd \-c 192\&.168\&.0\&.150,192\&.168\&.0\&.151\fR

677

.fi

678

.if n \{\

679

.RE

680

.\}

681

.sp

682

The same is true with regard to the connectstring used with any

683

\fBmysqld\fR

684

processes that you wish to start as MySQL Cluster SQL nodes connected to this cluster\&. See

685

Section\ \&17.3.2.3, \(lqThe MySQL Cluster Connectstring\(rq, for more information\&.

686

.sp

687

When used with

688

\fBndb_mgmd\fR, this option affects the behavior of the management node with regard to other management nodes only\&. Do not confuse it with the

689

\fB\-\-nowait\-nodes\fR

690

option used with

691

\fBndbd\fR

692

(or

693

\fBndbmtd\fR

694

in MySQL Cluster NDB 7\&.0 and later) to allow a cluster to start with fewer than its full complement of data nodes; when used with data nodes, this option affects their behavior only with regard to other data nodes\&.

695

.sp

696

Multiple management node IDs may be passed to this option as a comma\-separated list\&. Each node ID must be no less than 1 and no greater than 255\&. In practice, it is quite rare to use more than two management servers for the same MySQL Cluster (or to have any need for doing so); in most cases you need to pass to this option only the single node ID for the one management server that you do not wish to use when starting the cluster\&.

697

.if n \{\

698

.sp

699

.\}

700

.RS 4

701

.it 1 an-trap

702

.nr an-no-space-flag 1

703

.nr an-break-flag 1

704

.br

705

.ps +1

706

\fBNote\fR

707

.ps -1

708

.br

709

When you later start the

710

\(lqmissing\(rq

711

management server, its configuration must match that of the management server that is already in use by the cluster\&. Otherwise, it fails the configuration check performed by the existing management server, and does not start\&.

712

.sp .5v

713

.RE

714

This option was introduced in MySQL Cluster NDB 7\&.0\&.10\&.

715

.RE

716

.PP

717

It is not strictly necessary to specify a connectstring when starting the management server\&. However, if you are using more than one management server, a connectstring should be provided and each node in the cluster should specify its node ID explicitly\&.

718

.PP

719

See

720

Section\ \&17.3.2.3, \(lqThe MySQL Cluster Connectstring\(rq, for information about using connectstrings\&.

721

\fBndb_mgmd\fR(8), describes other options for

722

\fBndb_mgmd\fR\&.

723

.PP

724

The following files are created or used by

725

\fBndb_mgmd\fR

726

in its starting directory, and are placed in the

727

DataDir

728

as specified in the

729

config\&.ini

730

configuration file\&. In the list that follows,

731

\fInode_id\fR

732

is the unique node identifier\&.

733

.sp

734

.RS 4

735

.ie n \{\

736

\h'-04'\(bu\h'+03'\c

737

.\}

738

.el \{\

739

.sp -1

740

.IP \(bu 2.3

741

.\}

742

.\" MySQL Cluster: configuration

743

.\" configuring MySQL Cluster

744

.\" config.ini (MySQL Cluster)

745

config\&.ini

746

is the configuration file for the cluster as a whole\&. This file is created by the user and read by the management server\&.

747

Section\ \&17.3, \(lqMySQL Cluster Configuration\(rq, discusses how to set up this file\&.

748

.RE

749

.sp

750

.RS 4

751

.ie n \{\

752

\h'-04'\(bu\h'+03'\c

753

.\}

754

.el \{\

755

.sp -1

756

.IP \(bu 2.3

757

.\}

758

ndb_\fInode_id\fR_cluster\&.log

759

is the cluster events log file\&. Examples of such events include checkpoint startup and completion, node startup events, node failures, and levels of memory usage\&. A complete listing of cluster events with descriptions may be found in

760

Section\ \&17.5, \(lqManagement of MySQL Cluster\(rq\&.

761

.sp

762

When the size of the cluster log reaches one million bytes, the file is renamed to

763

ndb_\fInode_id\fR_cluster\&.log\&.\fIseq_id\fR, where

764

\fIseq_id\fR

765

is the sequence number of the cluster log file\&. (For example: If files with the sequence numbers 1, 2, and 3 already exist, the next log file is named using the number

766

4\&.)

767

.RE

768

.sp

769

.RS 4

770

.ie n \{\

771

\h'-04'\(bu\h'+03'\c

772

.\}

773

.el \{\

774

.sp -1

775

.IP \(bu 2.3

776

.\}

777

ndb_\fInode_id\fR_out\&.log

778

is the file used for

779

stdout

780

and

781

stderr

782

when running the management server as a daemon\&.

783

.RE

784

.sp

785

.RS 4

786

.ie n \{\

787

\h'-04'\(bu\h'+03'\c

788

.\}

789

.el \{\

790

.sp -1

791

.IP \(bu 2.3

792

.\}

793

ndb_\fInode_id\fR\&.pid

794

is the process ID file used when running the management server as a daemon\&.

795

.RE

796

.SH "COPYRIGHT"

797

.br

798

.PP

799

800

.PP

801

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

802

.PP

803

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

804

.PP

805

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

806

.sp

807

.SH "NOTES"

808

.IP " 1." 4

809

Bug#45588

810

.RS 4

811

\%http://bugs.mysql.com/bug.php?id=45588

812

.RE

813

.SH "SEE ALSO"

814

For more information, please refer to the MySQL Reference Manual,

815

which may already be installed locally and which is also available

816

online at http://dev.mysql.com/doc/.

817

.SH AUTHOR

818

Sun Microsystems, Inc. (http://www.mysql.com/).

Older »