Você precisa usar aspas duplas ( "
") em vez de aspas simples ( '
). Assim como o shell, perl e outras linguagens, as aspas simples no Puppet indicam uma string literal e inibem a interpolação variável interpretação de escapes de backslash.
file { '/etc/sysconfig/vncserver':
content => "VNCSERVERS=\"6:root\"\nVNCSERVERARGS[6]=\"-geometry 1152x864\"",}
Observe que eu tive que escapar das aspas duplas dentro da string.